Skip to main content

10.3 Query cash channel orders (collection, payment)

#Brief description: This interface is used to query cash channel collection and payment orders, and the order details can be viewed according to the order number.

Query parameters

Parameter nameTypeRequiredParameter meaningParameter description
orderIdstringNoPlatform order numberChoose 1 from our platform order number or merchant’s local order number
localOrderIdstringNoMerchant’s local order numberChoose 1 of 2 merchant’s local order number or our platform’s order number
keystringYesMerchant keyapiKey
signstringYesSignatureSee Signature Algorithm for details
Request json sample
{  
"key": "9yUreYgTRtit39Dy",
"orderId": 274224939517780,
"sign": "07792d2cf97811d3f2e7bd98edb477e3"
}

Return value

Parameter nameTypeParameter meaningParameter description
codeint32Request statusReturn code, 0 means the business is successful, otherwise it represents a different error
successbooleanSuccess statusSuccess identification, consistent with code=0, used for compatibility history
messagestringDescriptionError message. If there is an error, the error message returned
datajsonReturn dataSee the parameters below for details
Return to Example
{
"code": 0,
"success": true,
"message": null,
"data": {
"merchantId": 302992856974,
"merchantUserId": "conan",
"orderId": "477564506808517",
"localOrderId": "conantest9913279",
"type": "PAYMENT",
"status": "SUCCESS",
"currency": "CNY",
"paidAmount": "100",
"amount": "100",
"isReissue": false,
"notifyTime": 1772789295567,
"orderCreateTime": 1772789258844
}
}
data parameter description
Parameter nameTypeParameter meaningParameter description
merchantIdint64Merchant ID
merchantUserIdstringMerchant user IDValue corresponding to the order parameter localUserId
orderIdstringOrder numberOur platform order number
localOrderIdstringMerchant’s local order numberMerchant’s local platform order number (corresponding to the value of the order parameter localOrderId)
typeenumOrder TypePAYMENT:支付订单 | WITHDRAW:提款订单
statusenumOrder StatusPROCESSING:处理中| SUCCESS:已完成|FAIL:已失败
currencystringOrder currency
paidAmountnumberOrder receivable and payment amount
amountnumberOrder amount
isReissuebooleanWhether to reissue
notifyTimeint64Notification timestampMilliseconds
orderCreateTimeint64Order creation timestampMilliseconds